-
Notifications
You must be signed in to change notification settings - Fork 6
configure licensing, contributing guidelines, and project metadata #9
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
configure licensing, contributing guidelines, and project metadata #9
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This pull request establishes the legal and contribution framework for the Open Integration Engine™ documentation repository. It implements a dual-license strategy that allows flexible reuse of documentation while ensuring proper attribution, and sets clear guidelines for community contributions.
Changes:
- Added LICENSE file implementing a dual-license approach: CC-BY 4.0 for documentation/media and CC0 1.0 for code samples
- Enhanced README.md with comprehensive contributing guidelines, including DCO sign-off requirements, Bun-based development workflow, and protocols for handling third-party code
- Updated package.json with project metadata, SPDX license identifier, and private flag
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| LICENSE | Establishes dual-license framework with clear separation between documentation (CC-BY 4.0) and code samples (CC0 1.0), including appropriate disclaimers |
| README.md | Transforms basic usage instructions into comprehensive contributing guidelines with installation steps, development workflow, DCO requirements, and third-party code handling procedures |
| package.json | Adds project metadata including name, description, and proper SPDX license identifier for the dual-license approach |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Add `LICENSE` file implementing a dual-license strategy: CC-BY 4.0 for documentation text and CC0 1.0 for code samples. - Update `README.md` to integrate full contributing guidelines, including DCO sign-off requirements, Bun usage, and protocols for handling third-party code. - Update `package.json` metadata, including the SPDX license identifier `(CC-BY-4.0 AND CC0-1.0)` and `private` flag. Signed-off-by: Tony Germano <[email protected]>
2d3cb9f to
d420d7d
Compare
|
I think we have enough consensus here to move forward with this. 3 steering committee members, a maintainer, and a pending new contributor, which includes all of the authors of all historical commits. |
LICENSEfile implementing a dual-license strategy: CC-BY 4.0 for documentation text and CC0 1.0 for code samples.README.mdto integrate full contributing guidelines, including DCO sign-off requirements, Bun usage, and protocols for handling third-party code.package.jsonmetadata, including the SPDX license identifier(CC-BY-4.0 AND CC0-1.0)andprivateflag.